Usage

Assuming you have successfully installed and configured GetHelp, you should be rewarded by noticing very little difference in the behaviour of your Browser as it displays archive HTML help documents. You can simply open an archived HTML document from a file open requester, a web page with a link to an archived HTML document, drag a '.help' file icon onto the browser window or just double-click the '.help' file icon.

Note that your Browser file open requester may filter the list for files matching the format #?.html|#?.htm. If it does, then you may not see the '.help' file. Change the filter to read #? and all files will be displayed. Yes, that is annoying - good reason to link '.help' files from other documents... Another limitation is that it is not possible to add to hotlist - add pages to the Browser hotlist - as this will only link the cached page in Ram, which may or may not be there next time you look for it.

Let's look at how an Arexx script achieves all this, and some requirements of a '.help' file.

How does it work?

The GetHelp.rexx script has the following roles:

• Construct the temporary directory RAM:T/Help
• Unarchive the required .help file to a unique directory in RAM:T/Help
• Use a browser to display the main .html file of the document
• When the user quits the browser, delete the RAM:T/Help directory

The Gethelp system achieves all these functions within a single script by some clever recursive calls.

To really see what goes on, edit your GetHelp.rexx script and enter DEBUG=1 in the definitions section!

Using GetHelp from a Shell

It is possible to use the GetHelp Arexx script directly from the Shell:

rx GetHelp

To display a specific .help file, enter the file name as an argument to the script:

rx GetHelp AHI.help

If an error occurs, you can clear all temporary files by manually deleting the T:HELP directory or by entering the following:

rx GetHelp QUIT

This command will wait until the Browser has terminated, then delete all temporary files.

HotKey Configuration

In my system, I have configured MCP to start the Arexx script GetHelp.rexx when I hit rAMIGA+HELP keys. This starts my browser and displays my default Help screen and is the shell equivalent to entering rx GetHelp.